Add support to scheduler message #3487

lillo42 · 2025-01-20T14:56:37Z

codescene-delta-analysis

❌ Code Health Quality Gates: FAILED

Change in average Code Health of affected files: -0.02 (8.17 -> 8.15)

Declining Code Health: 4 findings(s) 🚩
Affected Hotspots: 2 files(s) 🔥

codescene-delta-analysis · 2025-01-20T14:57:14Z

src/Paramore.Brighter/CommandProcessor.cs

+            InstrumentationOptions instrumentationOptions = InstrumentationOptions.All,
+            IAmAMessageSchedulerFactory? messageSchedulerFactory = null)


ℹ Getting worse: Constructor Over-Injection
CommandProcessor increases from 8 to 9 arguments, threshold = 5

codescene-delta-analysis · 2025-01-20T14:57:15Z

src/Paramore.Brighter/CommandProcessor.cs

+            InstrumentationOptions instrumentationOptions = InstrumentationOptions.All,
+            IAmAMessageSchedulerFactory? messageSchedulerFactory = null)
+            : this(subscriberRegistry, handlerFactory, requestContextFactory, policyRegistry, featureSwitchRegistry, inboxConfiguration, messageSchedulerFactory: messageSchedulerFactory)


ℹ Getting worse: Constructor Over-Injection
CommandProcessor increases from 11 to 12 arguments, threshold = 5

codescene-delta-analysis

❌ Code Health Quality Gates: FAILED

Change in average Code Health of affected files: -0.02 (8.17 -> 8.15)

Declining Code Health: 4 findings(s) 🚩
Affected Hotspots: 2 files(s) 🔥

View detailed results in CodeScene

codescene-delta-analysis

❌ Code Health Quality Gates: FAILED

Change in average Code Health of affected files: -0.16 (8.69 -> 8.53)

Declining Code Health: 12 findings(s) 🚩
Improving Code Health: 2 findings(s) ✅
Affected Hotspots: 7 files(s) 🔥

View detailed results in CodeScene

codescene-delta-analysis · 2025-02-04T14:15:38Z

src/Paramore.Brighter/CommandProcessor.cs

@@ -37,6 +37,7 @@ THE SOFTWARE. */
 using Paramore.Brighter.FeatureSwitch;
 using Paramore.Brighter.Logging;
 using Paramore.Brighter.Observability;
+using Paramore.Brighter.Tasks;


❌ Getting worse: Code Duplication
introduced similar code in: SchedulerPost,SchedulerPost,SchedulerPostAsync,SchedulerPostAsync

_Suppress

codescene-delta-analysis · 2025-02-04T14:15:39Z

src/Paramore.Brighter/CommandProcessor.cs

@@ -37,6 +37,7 @@ THE SOFTWARE. */
 using Paramore.Brighter.FeatureSwitch;
 using Paramore.Brighter.Logging;
 using Paramore.Brighter.Observability;
+using Paramore.Brighter.Tasks;


ℹ Getting worse: Missing Arguments Abstractions
The average number of function arguments increases from 4.12 to 4.33, threshold = 4.00

codescene-delta-analysis · 2025-02-04T14:15:39Z

src/Paramore.Brighter/CommandProcessor.cs

+        public async Task<string> SchedulerPostAsync<TRequest>(TRequest request, 
+            TimeSpan delay,
+            RequestContext? requestContext = null,
+            Dictionary<string, object>? args = null,
+            bool continueOnCapturedContext = true, 
+            CancellationToken cancellationToken = default) where TRequest : class, IRequest
+        {
+            if (_messageSchedulerFactory == null)
+            {
+                throw new InvalidOperationException("No message scheduler factory defined.");
+            }
+
+            s_logger.LogInformation("Scheduling a request: {RequestType} {Id}", request.GetType(), request.Id);
+
+            var span = _tracer?.CreateSpan(CommandProcessorSpanOperation.Scheduler, request, requestContext?.Span, options: _instrumentationOptions);
+            var context = InitRequestContext(span, requestContext);
+
+            try
+            {
+                Message message = await s_mediator!.CreateMessageFromRequestAsync(request, context, cancellationToken);
+
+                var scheduler = _messageSchedulerFactory.Create(this);
+                return scheduler switch
+                {
+                    IAmAMessageSchedulerAsync async => await async.ScheduleAsync(message, delay, cancellationToken).ConfigureAwait(continueOnCapturedContext),
+                    IAmAMessageSchedulerSync sync => sync.Schedule(message, delay),
+                    _ => throw new InvalidOperationException("Message scheduler must be sync or async")
+                };
+            }
+            catch (Exception e)
+            {
+                _tracer?.AddExceptionToSpan(span, [e]);
+                throw;
+            }
+            finally
+            {
+                _tracer?.EndSpan(span);
+            }
+        }


ℹ New issue: Excess Number of Function Arguments
SchedulerPostAsync has 6 arguments, threshold = 4

codescene-delta-analysis · 2025-02-04T14:15:39Z

src/Paramore.Brighter/CommandProcessor.cs

+        public async Task<string> SchedulerPostAsync<TRequest>(TRequest request, 
+            DateTimeOffset at,
+            RequestContext? requestContext = null,
+            Dictionary<string, object>? args = null,
+            bool continueOnCapturedContext = true, 
+            CancellationToken cancellationToken = default) 
+            where TRequest : class, IRequest
+        {
+            if (_messageSchedulerFactory == null)
+            {
+                throw new InvalidOperationException("No message scheduler factory defined.");
+            }
+
+            s_logger.LogInformation("Scheduling a request: {RequestType} {Id}", request.GetType(), request.Id);
+
+            var span = _tracer?.CreateSpan(CommandProcessorSpanOperation.Scheduler, request, requestContext?.Span, options: _instrumentationOptions);
+            var context = InitRequestContext(span, requestContext);
+
+            try
+            {
+                Message message = await s_mediator!.CreateMessageFromRequestAsync(request, context, cancellationToken);
+
+                var scheduler = _messageSchedulerFactory.Create(this);
+                return scheduler switch
+                {
+                    IAmAMessageSchedulerAsync async => await async.ScheduleAsync(message, at, cancellationToken).ConfigureAwait(continueOnCapturedContext),
+                    IAmAMessageSchedulerSync sync => sync.Schedule(message, at),
+                    _ => throw new InvalidOperationException("Message scheduler must be sync or async")
+                };
+            }
+            catch (Exception e)
+            {
+                _tracer?.AddExceptionToSpan(span, [e]);
+                throw;
+            }
+            finally
+            {
+                _tracer?.EndSpan(span);
+            }
+        }


ℹ New issue: Excess Number of Function Arguments
SchedulerPostAsync has 6 arguments, threshold = 4

codescene-delta-analysis · 2025-02-04T14:15:39Z

src/Paramore.Brighter/CommandProcessor.cs

+            InstrumentationOptions instrumentationOptions = InstrumentationOptions.All,
+            IAmAMessageSchedulerFactory? messageSchedulerFactory = null)


ℹ Getting worse: Constructor Over-Injection
CommandProcessor increases from 8 to 9 arguments, threshold = 5

codescene-delta-analysis · 2025-02-04T14:15:45Z

src/Paramore.Brighter.MessagingGateway.RMQ/RmqMessageProducer.cs

@@ -144,13 +149,21 @@ public async Task SendWithDelayAsync(Message message, TimeSpan? delay, Cancellat

            _pendingConfirmations.TryAdd(await Channel.GetNextPublishSequenceNumberAsync(cancellationToken), message.Id);

-            if (DelaySupported)
+            if (delay == TimeSpan.Zero || DelaySupported)


❌ New issue: Complex Method
SendWithDelayAsync has a cyclomatic complexity of 10, threshold = 9

_Suppress

codescene-delta-analysis · 2025-02-04T14:15:46Z

src/Paramore.Brighter.MessagingGateway.RMQ/RmqMessageProducer.cs

@@ -144,13 +149,21 @@ public async Task SendWithDelayAsync(Message message, TimeSpan? delay, Cancellat

            _pendingConfirmations.TryAdd(await Channel.GetNextPublishSequenceNumberAsync(cancellationToken), message.Id);

-            if (DelaySupported)
+            if (delay == TimeSpan.Zero || DelaySupported)


❌ New issue: Bumpy Road Ahead
SendWithDelayAsync has 2 blocks with nested conditional logic. Any nesting of 2 or deeper is considered. Threshold is one single, nested block per function

_Suppress

codescene-delta-analysis · 2025-02-04T14:15:46Z

src/Paramore.Brighter.MessagingGateway.Redis/RedisMessageProducer.cs

        /// <returns>Task.</returns>
        public async Task SendWithDelayAsync(Message message, TimeSpan? delay, CancellationToken cancellationToken = default)
        {
-            await SendAsync(message, cancellationToken);


ℹ Getting worse: Code Duplication
introduced similar code in: SendWithDelay,SendWithDelayAsync

src/Paramore.Brighter.MessagingGateway.Redis/RedisMessageProducer.cs

codescene-delta-analysis · 2025-02-04T14:15:47Z

src/Paramore.Brighter/Observability/BrighterSpanExtensions.cs

@@ -42,6 +42,7 @@ public static class BrighterSpanExtensions
       CommandProcessorSpanOperation.Send => "send",
       CommandProcessorSpanOperation.Clear => "clear",
       CommandProcessorSpanOperation.Archive => "archive",
+       CommandProcessorSpanOperation.Scheduler => "scheduler",


❌ Getting worse: Complex Method
ToSpanName increases in cyclomatic complexity from 9 to 10, threshold = 9

_Suppress

codescene-delta-analysis

❌ Code Health Quality Gates: FAILED

Change in average Code Health of affected files: -0.16 (8.69 -> 8.53)

Declining Code Health: 12 findings(s) 🚩
Improving Code Health: 2 findings(s) ✅
Affected Hotspots: 7 files(s) 🔥

View detailed results in CodeScene

codescene-delta-analysis

❌ Code Health Quality Gates: FAILED

Change in average Code Health of affected files: -0.15 (8.69 -> 8.54)

Declining Code Health: 13 findings(s) 🚩
Improving Code Health: 2 findings(s) ✅
Affected Hotspots: 7 files(s) 🔥

View detailed results in CodeScene

codescene-delta-analysis

❌ Code Health Quality Gates: FAILED

Change in average Code Health of affected files: -0.15 (8.69 -> 8.54)

Declining Code Health: 13 findings(s) 🚩
Improving Code Health: 2 findings(s) ✅
Affected Hotspots: 7 files(s) 🔥

View detailed results in CodeScene

codescene-delta-analysis · 2025-02-05T09:34:50Z

src/Paramore.Brighter/InMemoryMessageScheduler.cs

+    public string Schedule(Message message, TimeSpan delay)
+    {
+        var id = getOrCreateSchedulerId(message);
+        if (s_timers.TryGetValue(id, out var timer))
+        {
+            if (onConflict == OnSchedulerConflict.Throw)
+            {
+                throw new InvalidOperationException($"scheduler with '{id}' id already exists");
+            }
+
+            timer.Dispose();
+        }
+
+        s_timers[id] = timeProvider.CreateTimer(Execute, (processor, id, message, false), delay, TimeSpan.Zero);
+        return id;
+    }


❌ New issue: Code Duplication
The module contains 2 functions with similar structure: Schedule,ScheduleAsync

_Suppress

iancooper

First, there is a tremendous amount of work here, that has broken the back of this. So thank you so much. I think my thoughts are generally:

Let's overload existing methods to take a DateTimeOffset scheduledAt parameter (and provide a helper method to create a scheduledAt from a TimeSpan that represents a delay) over new method names
We have different job types: Request (from CP goes back to send, post or publish, you need to know which) and Message (from a consumer implementation, used to delay posting a message, comes back to the consumer )
That makes your scheduler a bit more gnarly; you want an interface that the 3rd party lib support implements that offers either.

But once we have that this will solve a massive problem for us with supporting a Send at a point in time, which will be a really powerful addition in V10

iancooper · 2025-02-05T10:09:27Z

docs/adr/0024-Scheduling.md

+```c#
+public interface IAmACommandProcessor
+{
+    string SchedulerSend<TRequest>(TimeSpan delay, TRequest request) where TRequest : class, IRequest;


I wonder if we would be better off overloading Send with a time, than adding a new name here

Alternatively, how about SendAt, PublishAt, PostAt etc.

iancooper · 2025-02-05T10:15:14Z

src/Paramore.Brighter.MessagingGateway.AWSSQS/SnsMessageProducer.cs

+        {
+            if (Scheduler is IAmAMessageSchedulerAsync async)
+            {
+                await async.ScheduleAsync(message, delay.Value, cancellationToken);


Probably best to avoid a keyword in a variable name, use asyncScheduler instead?

iancooper · 2025-02-05T10:15:34Z

src/Paramore.Brighter.MessagingGateway.AWSSQS/SnsMessageProducer.cs

+
+            if (Scheduler is IAmAMessageSchedulerSync sync)
+            {
+                sync.Schedule(message, delay.Value);


Probably have to rename to strategy used above

iancooper · 2025-02-05T10:17:38Z

src/Paramore.Brighter.MessagingGateway.AWSSQS/SnsMessageProducer.cs

+                return;
+            }
+
+            if (Scheduler is IAmAMessageSchedulerSync sync)


Should we assume that an async path, always has an async scheduler, and only use the sync scheduler on a sync path (or if transport does not support sync and async, just resort to whichever matches? This allows us to make a blocking decision via the Brighter Sync Context

iancooper · 2025-02-05T10:18:53Z

src/Paramore.Brighter.MessagingGateway.AWSSQS/SqsMessageProducer.cs

+        delay ??= TimeSpan.Zero;
+        if (delay > TimeSpan.FromMinutes(15))
+        {
+            if (Scheduler is IAmAMessageSchedulerAsync async)


Same comments here on name (async)

iancooper · 2025-02-05T10:35:49Z

src/Paramore.Brighter/CommandProcessor.cs

+            }
+        }
+
+        public async Task<string> SchedulerPostAsync<TRequest>(TRequest request, 


The same comments apply. Overload with an At parameter over a new method convention; only one scheduler type

iancooper · 2025-02-05T10:36:47Z

src/Paramore.Brighter/InMemoryMessageScheduler.cs

+
+namespace Paramore.Brighter;
+
+public class InMemoryMessageScheduler(


Awesome, thanks for making sure we have one of these

iancooper · 2025-02-05T10:37:31Z

src/Paramore.Brighter/InMemoryMessageScheduler.cs

+    }
+
+    /// <inheritdoc cref="Dispose"/>
+    public void Dispose()


Do we need to ensure we dispose any remaining timers here?

iancooper · 2025-02-05T10:40:19Z

src/Paramore.Brighter.MessageScheduler.Quartz/QuartzBrighterJob.cs

+        var message = JsonSerializer.Deserialize<Message>(obj!, JsonSerialisationOptions.Options)!;
+        if (async)
+        {
+            await processor.PostAsync(new FireSchedulerMessage { Id = id, Message = message });


This works if our intent is always to send a message, but on a Send or Publish intent is actually just to delay Send or Publish.

iancooper · 2025-02-05T10:41:47Z

src/Paramore.Brighter.MessagingGateway.Redis/RedisMessageProducer.cs

+            delay ??= TimeSpan.Zero;
+            if (delay != TimeSpan.Zero)
+            {
+                if (Scheduler is IAmAMessageSchedulerAsync async)


usual comments on name and pick one

codescene-delta-analysis

❌ Code Health Quality Gates: FAILED

Change in average Code Health of affected files: +0.01 (8.74 -> 8.75)

Declining Code Health: 14 findings(s) 🚩
Improving Code Health: 2 findings(s) ✅
Affected Hotspots: 7 files(s) 🔥

View detailed results in CodeScene

codescene-delta-analysis · 2025-02-06T16:15:51Z

src/Paramore.Brighter.MessageScheduler.Aws/AwsMessageScheduler.cs

@@ -0,0 +1,402 @@
+using System.Collections.Concurrent;


❌ New issue: Primitive Obsession
In this module, 31.7% of all function arguments are primitive types, threshold = 30.0%

_Suppress

codescene-delta-analysis

❌ Code Health Quality Gates: FAILED

Change in average Code Health of affected files: +0.01 (8.74 -> 8.75)

Declining Code Health: 14 findings(s) 🚩
Improving Code Health: 2 findings(s) ✅
Affected Hotspots: 7 files(s) 🔥

View detailed results in CodeScene

codescene-delta-analysis · 2025-02-07T11:09:53Z

src/Paramore.Brighter.MessageScheduler.Quartz/QuartzMessageScheduler.cs

+    public string Schedule(Message message, DateTimeOffset at)
+    {
+        var id = getOrCreateSchedulerId(message);
+        var job = JobBuilder.Create<QuartzBrighterJob>()
+            .WithIdentity(getOrCreateSchedulerId(message), group!)
+            .UsingJobData("message", JsonSerializer.Serialize(
+                new FireSchedulerMessage { Id = id, Async = false, Message = message },
+                JsonSerialisationOptions.Options))
+            .Build();
+
+        var trigger = TriggerBuilder.Create()
+            .WithIdentity(getOrCreateSchedulerId(message) + "-trigger", group!)
+            .StartAt(at)
+            .Build();
+
+       var tmp = BrighterAsyncContext.Run(async () => await scheduler.ScheduleJob(job, trigger));
+        return id;
+    }


❌ New issue: Code Duplication
The module contains 2 functions with similar structure: Schedule,ScheduleAsync

_Suppress

codescene-delta-analysis

❌ Code Health Quality Gates: FAILED

Change in average Code Health of affected files: +0.01 (8.74 -> 8.75)

Declining Code Health: 14 findings(s) 🚩
Improving Code Health: 2 findings(s) ✅
Affected Hotspots: 7 files(s) 🔥

View detailed results in CodeScene

lillo42 added 6 commits January 17, 2025 15:15

Init Message Scheduler V1

44af426

Init support to scheduler messages

b8d365b

Improve scheduler

6ddfa0c

Improve scheduler

8fa4a58

Add ADR

0c54163

rollback unnecessary changes

42b904c

codescene-delta-analysis bot reviewed Jan 20, 2025

View reviewed changes

Merge branch 'master' into message-scheduler-v1

69d2871

codescene-delta-analysis bot reviewed Jan 20, 2025

View reviewed changes

iancooper assigned lillo42 Jan 22, 2025

iancooper added 2 - In Progress grabbed by assignee feature request .NET Pull requests that update .net code Draft This is a work in progress labels Jan 22, 2025

lillo42 added 4 commits February 3, 2025 17:00

Improve Scheduler support

b377821

Improve scheduler messages

3cfa7f3

Fixes unit tests

cd0ec7f

Add Unit test

aff9240

codescene-delta-analysis bot reviewed Feb 4, 2025

View reviewed changes

Merge branch 'master' into message-scheduler-v1

172f9c2

codescene-delta-analysis bot reviewed Feb 4, 2025

View reviewed changes

Remove Hangfire and add Quartz

0bed01e

codescene-delta-analysis bot reviewed Feb 4, 2025

View reviewed changes

lillo42 added 2 commits February 5, 2025 08:56

Fixes unit test

a6abc68

Quartz Add support to .NET Standard & .NET 9.0

c266d09

codescene-delta-analysis bot reviewed Feb 5, 2025

View reviewed changes

iancooper reviewed Feb 5, 2025

View reviewed changes

lillo42 added 2 commits February 6, 2025 08:33

Add AWS Scheduler

6340079

Add Missing file

dad21ca

Add AWS Scheduler

834cf17

codescene-delta-analysis bot reviewed Feb 6, 2025

View reviewed changes

Add Scheduler Samples

b908bb9

codescene-delta-analysis bot reviewed Feb 7, 2025

View reviewed changes

Merge branch 'master' into message-scheduler-v1

d83b7b9

codescene-delta-analysis bot reviewed Feb 7, 2025

View reviewed changes

		InstrumentationOptions instrumentationOptions = InstrumentationOptions.All,
		IAmAMessageSchedulerFactory? messageSchedulerFactory = null)


		namespace Paramore.Brighter;

		public class InMemoryMessageScheduler(

Add support to scheduler message #3487

Are you sure you want to change the base?

Add support to scheduler message #3487

Conversation

lillo42 commented Jan 20, 2025 • edited Loading

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

codescene-delta-analysis bot Jan 20, 2025

Choose a reason for hiding this comment

codescene-delta-analysis bot Jan 20, 2025

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

codescene-delta-analysis bot Feb 4, 2025

Choose a reason for hiding this comment

codescene-delta-analysis bot Feb 4, 2025

Choose a reason for hiding this comment

codescene-delta-analysis bot Feb 4, 2025

Choose a reason for hiding this comment

codescene-delta-analysis bot Feb 4, 2025

Choose a reason for hiding this comment

codescene-delta-analysis bot Feb 4, 2025

Choose a reason for hiding this comment

codescene-delta-analysis bot Feb 4, 2025

Choose a reason for hiding this comment

codescene-delta-analysis bot Feb 4, 2025

Choose a reason for hiding this comment

codescene-delta-analysis bot Feb 4, 2025

Choose a reason for hiding this comment

codescene-delta-analysis bot Feb 4, 2025

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

codescene-delta-analysis bot Feb 5, 2025

Choose a reason for hiding this comment

iancooper left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

codescene-delta-analysis bot Feb 6, 2025

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

codescene-delta-analysis bot Feb 7, 2025

Choose a reason for hiding this comment

codescene-delta-analysis bot left a comment

Choose a reason for hiding this comment

lillo42 commented Jan 20, 2025 •

edited

Loading